Package org.mozilla.jss.crypto

Interface PrivateKey

All Superinterfaces:

Destroyable, Key, PrivateKey, Serializable

All Known Implementing Classes:

PK11DSAPrivateKey, PK11ECPrivateKey, PK11PrivKey, PK11RSAPrivateKey

public interface PrivateKey
extends PrivateKey

Private Keys used by JSS. All the private keys handled by JSS are of this type, which is a subtype of java.security.PrivateKey.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PrivateKey.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final PrivateKey.Type	DiffieHellman
static final PrivateKey.Type	DSA
static final PrivateKey.Type	EC
static final PrivateKey.Type	MLDSA	Generic ML-DSA alias; resolves to ML-DSA-65 (NIST security level 3).
static final PrivateKey.Type	MLDSA44
static final PrivateKey.Type	MLDSA65
static final PrivateKey.Type	MLDSA87
static final PrivateKey.Type	MLKEM	Generic ML-KEM alias; resolves to ML-KEM-768 (NIST security level 3).
static final PrivateKey.Type	MLKEM1024
static final PrivateKey.Type	MLKEM512
static final PrivateKey.Type	MLKEM768
static final PrivateKey.Type	RSA

Fields inherited from interface java.security.PrivateKey

serialVersionUID

Method Summary

Modifier and Type	Method	Description
CryptoToken	getOwningToken()	Returns the CryptoToken that owns this private key.
default AlgorithmParameterSpec	getParams()
int	getStrength()	Returns the size, in bits, of the modulus of an RSA key.
PrivateKey.Type	getType()	Returns the type (RSA, DSA, ML-DSA or ML-KEM) of this private key.
byte[]	getUniqueID()	Returns the unique ID of this key.

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Methods inherited from interface java.security.Key

getAlgorithm, getEncoded, getFormat

Field Details

RSA

static final PrivateKey.Type RSA

DSA

static final PrivateKey.Type DSA

EC

static final PrivateKey.Type EC

MLKEM512

static final PrivateKey.Type MLKEM512

MLKEM768

static final PrivateKey.Type MLKEM768

MLKEM

static final PrivateKey.Type MLKEM

Generic ML-KEM alias; resolves to ML-KEM-768 (NIST security level 3).

MLKEM1024

static final PrivateKey.Type MLKEM1024

MLDSA44

static final PrivateKey.Type MLDSA44

MLDSA65

static final PrivateKey.Type MLDSA65

MLDSA

static final PrivateKey.Type MLDSA

Generic ML-DSA alias; resolves to ML-DSA-65 (NIST security level 3).

MLDSA87

static final PrivateKey.Type MLDSA87

DiffieHellman

static final PrivateKey.Type DiffieHellman

Method Details

getType

PrivateKey.Type getType()
                 throws KeyException

Returns the type (RSA, DSA, ML-DSA or ML-KEM) of this private key.

Throws:

KeyException

getUniqueID

byte[] getUniqueID()
            throws TokenException

Returns the unique ID of this key. Unique IDs can be used to match certificates to keys.

Throws:

TokenException

See Also:

• PK11Cert.getUniqueID()

getStrength

int getStrength()

Returns the size, in bits, of the modulus of an RSA key. Returns -1 for other types of keys.

getParams

default AlgorithmParameterSpec getParams()

getOwningToken

CryptoToken getOwningToken()

Returns the CryptoToken that owns this private key. Cryptographic operations with this key may only be performed on the token that owns the key.